home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / tag_bbs / tn31b.zip / TAGNITE.DOC < prev    next >
Text File  |  1993-01-08  |  14KB  |  361 lines

  1.                           TAGNITE UTILITY V3.1
  2.  
  3. Note: See history.doc for updates in 3.1.
  4.  
  5. TAGNITE is a nightly utility program written for TAG 2.6.  To
  6. date, TAGNITE will delete inactive users, delete EMail to deleted
  7. users, delete any macros belonging to deleted users, modify up to
  8. 12 files (ASCII or ANSI) with names and amounts or 
  9. uploads/downloads/publicposts, and rebuild NAMES.LST if needed.  
  10. Included in this zip file should be 8 files:
  11.  
  12.        TAGNITE.EXE - main program
  13.        TAGNITE.CFG - configuration file
  14.        TAGNITE.DOC - documentation
  15.        TAGNITE.CLR - sample color ansi output template
  16.        TAGNITE.MSG - sample ascii output template     
  17.        HISTORY.DOC - listing of the modifications to TAGNITE
  18.        SLTIMES.EXE - Sets up security levels and times
  19.        REMOVE.EXE  - Remove '`' marks from USER.LST.
  20.  
  21.                        THE CONFIGURATION FILE
  22.  
  23. The sample configuration file that you now have is called
  24. TAGNITE.CFG, but can be called anything you like.  The name of
  25. the configuration file is passed to TAGNITE through a command
  26. line parameter (this will be explained later).  The best way to
  27. explain the configuration file commands will be by showing you
  28. the TAGNITE.CFG file and explaining the options used and telling
  29. you about the variations on each command. So, print out a copy of
  30. the .CFG file or pull it into an editor or word processor. After
  31. each command is explained, take a minute to look at how it is
  32. used in the sample .CFG file.  If the first character on a line
  33. is a percent '%' sign, the line is ignored, or said to be
  34. remarked out. If a double percent '%%' is encountered as the
  35. first 2 characters of a line, all lines after are treated as a
  36. remark, until another set of double percents are encountered as
  37. the first 2 characters of a line.  The rest of this section will
  38. list a command, followed by the explanation of it,followed by an.
  39.  
  40. GFILES PATH=<drive & path>
  41.      Tells where to find the tag\gfiles directory. The path MUST
  42.      be followed by a '\'.
  43. GFILES PATH=C:\TAG\GFILES\
  44.  
  45. TAG PATH=<drive & path>
  46.      Tells where to find the main tag directory. The path MUST be
  47.      followed by a'\'.
  48. TAG PATH=C:\TAG\
  49.  
  50. TAGNITE PATH=<drive & path> 
  51.      Tells where to find the path to TAGNITE.  The path MUST be
  52.      followed by a'\'.
  53. TAGNITE PATH=C:\TAG\TAGNITE\
  54.  
  55. DELETE DAYS=<0-32767>
  56.      Tells how many days that a user must not have called before
  57.      the user will be deleted. 0 days tells TAGNITE not to delete
  58.      any users.
  59. DELETE DAYS=90
  60.  
  61. DELETE SL=<security level>
  62.      Tells TAGNITE to only delete users who's SL is equal to or
  63.      less than the delete SL.
  64. DELETE SL=199
  65.  
  66. DELETE TIMES CALLED=<0-32767>
  67.      Tells TAGNITE to only count users who have called X number
  68.      of times or less. (Since a user who has only called 1 or 2
  69.      times total, then not called for 90 days is likely to be
  70.      someone who will not call again, but a user who has called
  71.      500 times then not called for 90 days most likely is just
  72.      away) 0 in this field tells TAGNITE to not use this # in
  73.      deciding if a user is to be deleted.
  74. DELETE TIMES CALLED=0
  75. * NOTE * - TAGNITE will not delete a user whos PROTECTION FROM
  76. DELETION flag is set.
  77.  
  78. REPORT=<filename>
  79.      This is the log file that info on the daily runs will be
  80.      placed into.
  81. REPORT=C:\TAG\TAGNITE.LOG
  82.  
  83. TOP DATE SYMBOL=<character>
  84.      When this symbol is encountered in a template file, it is
  85.      replaced with the current date (MM/DD/YY).
  86. TOP DATE SYMBOL=`
  87.  
  88. TOP NAME LENGTH=<0-64>
  89.      This is the size that the user name output in the output
  90.      files will be. The field will be truncated or padded as
  91.      needed.
  92. TOP NAME LENGTH=25
  93.  
  94. TOP INPUT FILE=<filename>
  95.      This is the name of a template file used in the creation of
  96.      bulletin or logon files.
  97. TOP INPUT FILE=C:\TAG\GFILES\LOGON3M.DAT  
  98.  
  99. TOP OUTPUT FILE=<filename>
  100.      This is the name of an outputfile that is created with the
  101.      help of the main template.
  102. TOP OUTPUT FILE=C:\TAG\GFILES\LOGON3.MSG
  103. *NOTE* the top output and input must be paired off. THERE MUST ME 
  104.       AN EQUAL NUMBER OF EACH (up to 12 each!)
  105.  
  106.  
  107. LEECH SYMBOL=<character>
  108.      When this symbol is encountered in a template file followed
  109.      by a number, it will be replaced with the leech of this
  110.      orders name. If it is encountered followed by a number
  111.      followed by the leech symbol again, it will be replaced with
  112.      the leech amount.
  113. LEECH SYMBOL=%
  114.  
  115. LEECH SL=<security level>
  116.      Tells TAGNITE to only count users whos SL is equal to or
  117.      less than the leech SL.
  118. LEECH SL=199
  119.  
  120. LEECH CHECK BY=<R/C>
  121.      Tells TAGNITE how to calculate leeching.'C' means per call
  122.      leeching.'R' means ratio of downloads to uploads.
  123. LEECH CHECK BY=R
  124.  
  125. LEECH BY=<K/D>
  126.      Tells TAGNITE to calculate leech formulas with K-bytes or
  127.      number of Downloads.
  128. LEECH BY=K
  129.  
  130. UPLOAD SYMBOL=<character>
  131.      When this symbol is encountered in a template file followed
  132.      by a number, it will be replaced with the uploader of this
  133.      orders name. If it is encountered followed by a number
  134.      followed by the uploader symbol again, it will be replaced
  135.      with the uploaders amount.
  136. UPLOAD SYMBOL=^
  137.  
  138. UPLOAD SL=<security level>
  139.      Tells TAGNITE to only count users whos SL is equal to or
  140.      less than the uploader SL.
  141. UPLOAD SL=199
  142.  
  143.  
  144. UPLOAD CHECK BY=<R/C>
  145.      Tells TAGNITE how to calculate uploading.'C' means per call
  146.      uploads.'R' means ratio of uploads to downloads.
  147. UPLOAD CHECK BY=R
  148.  
  149. UPLOAD BY=<K/D>
  150.      Tells TAGNITE to calculate upload formulas with          
  151.      K-bytes or number of uploads.
  152. UPLOAD BY=K
  153.  
  154. POST SYMBOL=<character> - when this symbol is encountered in a    
  155.       template file followed by a number, it will be replaced     
  156.      with the poster of this orders name. If it is          
  157. encountered followed by a number followed by the poster          
  158. symbol again, it will be replaced with the posters          
  159. amount.(POST IS ONLY CALC'D BY #POSTS PER CALL)
  160. POST SYMBOL=@
  161.  
  162. POST SL=<security level>
  163.      Tells TAGNITE to only count user whos SL is equal to or less
  164.      than the post SL.
  165. POST SL=199
  166.  
  167. MAX TIME SL=<security level>
  168.      Tells TAGNITE what the upper SL limit is when calculating a
  169.      new SL.
  170. MAX TIME SL=180
  171.  
  172. MIN TIME SL=<security level>
  173.      Tells TAGNITE what the lower SL limit is when calculating a
  174.      new SL.
  175. MIN TIME SL=5
  176.  
  177. LOGON SL CHANGE=<amount>
  178.      Tells TAGNITE how much to add or subtract to the base SL
  179.      based on how many times the user has logged on.
  180. LOGON SL CHANGE=-2
  181.  
  182. POST SL CHANGE=<amount>
  183.      Tells TAGNITE how much to add or subtract to the base SL
  184.      based on how many times the user has made a public post. 
  185. POST SL CHANGE=3
  186.  
  187. UPLOAD SL CHANGE=<amount>
  188.      Tells TAGNITE how much to add or subtract to the base SL
  189.      based on how many files the user has uploaded.
  190. UPLOAD SL CHANGE=5
  191.  
  192. DOWNLOAD SL CHANGE=<amount>
  193.      Tells TAGNITE how much to add or subtract to the base SL
  194.      based on how many files the user has downloaded.
  195. DOWNLOAD SL CHANGE=-3
  196.  
  197. BASE TIME SL=<security level>
  198.      Tells TAGNITE what security level to use as a starting point
  199.      before adding and subtracting for
  200.      posts/logons/uploads/downloads.
  201. BASE TIME SL=45
  202.  
  203. REPORT LOGON ATTEMPTS=<number of illegal logon attempts>
  204.      This tells TAGNITE to report illegal logon attempts on an
  205.      account that exceeds this number when TAGNITE is run.
  206. REPORT LOGON ATTEMPTS=5
  207.  
  208. SEND MESSAGES TO=<user number>
  209.      All important messages that go in the report file can also
  210.      be placed in a 1 line message to the specified user. If this
  211.      user has his mail be forwarded, then the forwarded to user
  212.      will get the messages. If set to 0 no messages will be sent.
  213. SEND MESSAGES TO=1  
  214.  
  215. CHECK STATE BY ZIPCODE
  216.      If this line is present in the configuration file, TAGNITE
  217.      will attempt to verify a user's zipcode against the state
  218.      that the user is in.
  219.  
  220. NOTIFY USERS OF PROBLEMS
  221.      If this line is present in the configuration file, TAGNITE
  222.      will send "SHORT MESSAGES" telling him that there is a
  223.      problem with his account. (i.e. bad zipcode/state
  224.      combination).
  225.                    WHAT IS A TEMPLATE FILE?
  226.  
  227. The template files are optional files that allow you to format
  228. the 'top output' files. After TAGNITE calculates the amounts for
  229. leeches, uploaders, and/or posters, it then sorts them from the
  230. highest to lowest. It then reads in your template files and looks
  231. for the symbols telling where to insert data. (TAGNITE INSERTS,
  232. NOT OVERWRITES). Thus, if the template file line read as follows:
  233.  
  234.      TODAYS DATE IS `!<C/R>
  235.  
  236. if ` is the symbol for the current date, then the output files
  237. version of the line will read as follows:
  238.  
  239. TODAYS DATE IS 05/09/91!<C/R>
  240.  
  241. The leech, upload, and post symbols all act in the same way, so
  242. to save myself time, I shall explain it with only the post
  243. example. Let us say that the post symbol is @, and the output
  244. name length is set to 10. Giving the following template file:
  245.  
  246.      TOP 2 POSTERS AS OF `.<C/R>
  247.      1) @1@ posts per call for @1.<C/R>
  248.      2) @2@ posts per call for @2.<C/R>
  249.  
  250. The output file should read something like this:
  251.  
  252.      TOP 2 POSTERS AS OF 05/08/91.<C/R>
  253.      1) 2.23 posts per call for King Arthu.<C/R>
  254.      2) 2.21 posts per call for Fireman   .<C/R>
  255.  
  256. Note that the 2nd line was truncated on the name, and the 3rd
  257. line was padded on the name.            WHAT IS THIS ABOUT RECALCULATION OF THE SL?
  258.  
  259. One of the features of TAGNITE lets you restrict people by time,
  260. rather than by the ratios that TAG lets you use.  I use this
  261. feature on my bbs, and the concept is simple.  TAGNITE will give
  262. time or take time from a user each time they post a public
  263. message, logon the system, upload a file, or download a file. You
  264. set the limits on the time given, and who can be recalculated. If
  265. the Ignore Ratio flag is set on a user, TAGNITE will not
  266. recalculate the time. Also if the users SL is above the MAX TIME
  267. SL or below the MIN TIME SL the time will not be recalculated. On
  268. my bbs I take 2 minutes each time a user calls. This is because
  269. if they call and do nothing positive for the bbs then I do not
  270. feel that the call was worth it. I give 3 minutes for each public
  271. post, take 3 minutes for each download, and give 5 minutes for
  272. each upload.  The catch is that TAG does not keep track of the
  273. users time, but time used. So what TAGNITE changes is the users
  274. SL. Since the SL directly effects the users time. Just make sure
  275. that you make the SL time between the MIN and MAX SL TIME levels
  276. go in increments of 1 minute. To speed you up in modifying the SL
  277. times, I have written a program called SLTIMES.EXE, this will
  278. make the time equal the SL level. Just run it if you want to use
  279. the time feature of TAGNITE, and only run it once (it only
  280. changes the SL times for level 1 thru 254).                  WHAT ARE THE CONFIG DEFAULTS? Option             
  281. Default if option not in .CFG file.
  282. -----------------------------------------
  283. Delete days         90 days
  284. Delete Report       No report
  285. Delete Times Called 0 (do not use this field in deletion)
  286. Delete SL           0 (no deletion of users)
  287. Leech Symbol        No symbol set (no leech calcs done)
  288. Leech SL            0 (no leech calcs done)
  289. Leech Check         C (calculate by calls)
  290. Leech Type          D (calculate by number of dls)
  291. Upload Symbol       No symbol set (no upload calcs done)
  292. Upload SL           0 (no upload calcs done)
  293. Upload Check        C (calculate by calls)
  294. Upload Type         D (calculate by number of uls)
  295. Post Symbol         No Symbol set (no post calcs done)
  296. Post SL             0 (no post calcs done)
  297. Top Input Files     NUL (no template files or output files used)
  298. Top Output Files    NUL (no template files or output files used)
  299. Top Name Length     36
  300. Max Time SL         0 (no SL calcs done)
  301. Min Time SL         0 (no SL calcs done)
  302. Logon SL Change     0 (no SL change for logons)
  303. Post SL Change      0 (no SL change for posts) 
  304. Upload SL Change    0 (no SL change for uploads)
  305. Download SL Change  0 (no SL change for downloads)
  306. Base Time SL        0 (the only movement on the SL can be up)
  307. Report Logon Attempts 0 (no reporting of them)
  308. Report Messages To  1 (this should be the sysop)
  309.  
  310. NOTE: ANY OPTIONS NOT LISTED MUST BE DEFINED IN THE .CFG FILE!                      HOW DO I RUN TAGNITE?
  311.  
  312. Simple question, simple answer. at a DOS prompt or in an event
  313. batch file enter the following:
  314.  
  315. TAGNITE <configuration filename>
  316.  
  317. <configuration filename> defaults to TAGNITE.CFG in the current
  318. directory.
  319.  
  320.                    CREDIT WHERE CREDIT IS DUE
  321.  
  322. Thanks must be given to the following people:
  323.  
  324. Robert Numerick and Victor Capton for the listing of the TAG 2.6  
  325. data structures.
  326.  
  327. John Haluska for his Quicksort routines for Pascal.
  328.  
  329. Peter Yao for pointing out slight oversights in TAGNITE.
  330.  
  331. Mike Depetris for helping test TAGNITE.
  332.  
  333. David de Gil making TAGNITE to version 2.9B.
  334.  
  335. Ira Tessler for caring for TAGNITE to version 3.1.                   
  336.  
  337. Paul Ingles without whoms cries David de Gil would not have taken
  338.      Tagnite back to update.
  339.  
  340. Coca-Cola Company for all the cans of Diet Coke I went through during
  341.      the creation of this program.
  342.  
  343.                        ALMOST DONE
  344.  
  345. We have other features that we plan to put in the next versions
  346. of TAGNITE, but I would like to hear from you on what new
  347. features you would like to see in the future releases of TAGNITE. 
  348.  
  349.  
  350.                        DONATIONS
  351.  
  352. If you find this software useful, please send a donation of $20
  353. to:
  354.  
  355.  
  356. David de Gil
  357. TAGNITE
  358. P.O. Box 176
  359. Prospect Heights, IL 60070-0176
  360.  
  361.